Skip to content

feat : Enhance README with troubleshooting and FAQ sections - #1739

Merged
magic-peach merged 3 commits into
reframe-oss:mainfrom
Dippp10-ally:patch-1
Sep 15, 2026
Merged

feat : Enhance README with troubleshooting and FAQ sections#1739
magic-peach merged 3 commits into
reframe-oss:mainfrom
Dippp10-ally:patch-1

Conversation

@Dippp10-ally

@Dippp10-ally Dippp10-ally commented Aug 12, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

Description

Added Troubleshooting and FAQ sections to the README to help contributors and users quickly find solutions to common issues and frequently asked questions. This improves the documentation, onboarding experience, and self-service support.

Related Issue

Closes #1738

Type of Contribution

  • Bug fix
  • New feature
  • Documentation update
  • Refactor
  • GSSoC contribution

Participant Info

  • GitHub username: Dippp10-ally
  • Contribution level (Beginner/Intermediate/Advanced): Intermediate

Screen Recording

Not applicable. This is a documentation-only change and does not introduce or modify UI, interactive functionality, or application behavior.

Recording / Loom link: N/A

Checklist

  • I have read the contribution guidelines
  • My changes follow the project structure
  • I have tested my changes in Chrome, Firefox, and Safari
  • bun run lint passes (no ESLint errors)
  • bunx tsc --noEmit passes (no TypeScript errors)
  • New interactive elements have aria-label / accessible names
  • No console.log statements left in
  • This PR is related to a valid issue
  • Screen recording attached above — Not applicable for documentation-only changes

@Dippp10-ally
Enhance README with troubleshooting and FAQ sections
68bb474 
Added troubleshooting and FAQ sections to README.
@vercel

vercel Bot commented Aug 12, 2026

Copy link
Copy Markdown

@Dippp10-ally is attempting to deploy a commit to the magic-peach1's projects Team on Vercel.

A member of the Team first needs to authorize it.

@github-actions github-actions Bot added level:beginner Beginner level - 20 pts type:bug Bug fix type:design UI/UX design type:docs Documentation type:feature New feature type:refactor Code refactor labels Aug 12, 2026
@github-actions

github-actions Bot commented Aug 12, 2026

Copy link
Copy Markdown
Contributor

👋 Thanks for your PR, @Dippp10-ally!

Welcome to Reframe — a browser-based video editor built for everyone 🎬

🟠 GSSoC'26 PR detected — thanks for contributing under GirlScript Summer of Code 2026!

What happens next

  1. 🤖 Automated checks — build & TypeScript typecheck will run automatically
  2. ✅ Vercel preview — a preview deployment will be created (requires maintainer authorization for fork PRs)
  3. 👀 Code review — a maintainer will review your changes
  4. 🚀 Merge — once approved, your PR will be merged!

Quick checklist

  • PR title follows Conventional Commits (e.g. feat: add dark mode)
  • Linked the issue this PR closes (e.g. Closes #123)
  • Tested the changes locally (bun run dev)
  • Build passes (bun run build)

Useful links

Happy coding! 🎉

@github-actions github-actions Bot added the gssoc'26 GirlScript Summer of Code 2026 label Aug 12, 2026
@github-actions

github-actions Bot commented Aug 12, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

⚠️ PR Format Issues — @Dippp10-ally

Please fix the following before your PR can be reviewed:

  • ⚠️ Use a conventional PR title. Examples:
    • feat: add dark mode support
    • fix: resolve aria label missing on slider
    • docs: add deployment guide to README

Push new commits after fixing — this comment will update automatically.

📖 CONTRIBUTING.md

@Dippp10-ally

Dippp10-ally commented Aug 12, 2026

Copy link
Copy Markdown
Contributor Author

@magic-peach ji , do assign labels called as gssoc:approved, level:intermediate, type:docs , quality:exceptional to above pull request number 1739 also....do merge above pull request number 1739 also.....

@Dippp10-ally Dippp10-ally changed the title Enhance README with troubleshooting and FAQ sections feat : Enhance README with troubleshooting and FAQ sections Aug 12, 2026
@magic-peach magic-peach added the status:awaiting-review Clean PR waiting on a maintainer, not the author label Aug 14, 2026
@github-actions

github-actions Bot commented Sep 5, 2026

Copy link
Copy Markdown
Contributor

👋 This PR has been inactive for 21 days. It will be automatically closed in 14 days if there's no further activity.

If you need help with this PR, please comment or ping a maintainer.
Make sure your branch is rebased onto main and all CI checks pass.

@github-actions github-actions Bot added the needs-fixes PR has issues that need to be fixed label Sep 5, 2026
magic-peach and others added 2 commits September 15, 2026 23:32
@magic-peach
Merge remote-tracking branch 'origin/main' into patch-1
21c723a
@magic-peach @claude
docs: use bun instead of npm in new Troubleshooting/FAQ sections
264c4b0 
This repo uses bun (bun.lock is the source of truth, CLAUDE.md explicitly
rejects npm/yarn lockfiles) — the added sections referenced npm install/
npm run dev, which would send a new contributor down the wrong path.

Co-Authored-By: Claude Sonnet 5 <[email protected]>
Claude-Session: https://claude.ai/code/session_01L5gqyU5QKQtLAza6hL6dXv
@magic-peach

magic-peach commented Sep 15, 2026

Copy link
Copy Markdown
Collaborator

Content looks good and genuinely Reframe-relevant — I fixed one thing before merging: the FAQ/Troubleshooting used npm install/npm run dev, but this repo is bun-only (see CLAUDE.md). Swapped those for bun install/bun run dev and pointed the env-vars note at .env.local/.env.example to match how this project actually works. (Separately: the issue you linked, #1738, was closed as unrelated content — unaffected here, since your PR's own diff was always genuinely about Reframe.)

@netlify

netlify Bot commented Sep 15, 2026 •
edited
Loading

Copy link
Copy Markdown

✅ Deploy Preview for reframe-os ready!

Name Link
🔨 Latest commit 264c4b0
🔍 Latest deploy log https://app.netlify.com/projects/reframe-os/deploys/6aa988835e381f000834297e
😎 Deploy Preview https://deploy-preview-1739--reframe-os.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@magic-peach
magic-peach merged commit 0213835 into reframe-oss:main Sep 15, 2026
18 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

gssoc'26 GirlScript Summer of Code 2026 level:beginner Beginner level - 20 pts needs-fixes PR has issues that need to be fixed status:awaiting-review Clean PR waiting on a maintainer, not the author type:bug Bug fix type:design UI/UX design type:docs Documentation type:feature New feature type:refactor Code refactor

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

[FEATURE] : add Troubleshooting Guide and FAQ to Documentation

2 participants

@Dippp10-ally @magic-peach